home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / include / content / nsXMLNameSpaceMap.h < prev   
C/C++ Source or Header  |  2006-05-08  |  4KB  |  101 lines
  1. /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
  2. /* ***** BEGIN LICENSE BLOCK *****
  3.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4.  *
  5.  * The contents of this file are subject to the Mozilla Public License Version
  6.  * 1.1 (the "License"); you may not use this file except in compliance with
  7.  * the License. You may obtain a copy of the License at
  8.  * http://www.mozilla.org/MPL/
  9.  *
  10.  * Software distributed under the License is distributed on an "AS IS" basis,
  11.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12.  * for the specific language governing rights and limitations under the
  13.  * License.
  14.  *
  15.  * The Original Code is Mozilla Communicator client code.
  16.  *
  17.  * The Initial Developer of the Original Code is
  18.  * IBM Corporation.
  19.  * Portions created by the Initial Developer are Copyright (C) 2005
  20.  * the Initial Developer. All Rights Reserved.
  21.  *
  22.  * Contributor(s):
  23.  *  Brian Ryner <bryner@brianryner.com>
  24.  *
  25.  * Alternatively, the contents of this file may be used under the terms of
  26.  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27.  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28.  * in which case the provisions of the GPL or the LGPL are applicable instead
  29.  * of those above. If you wish to allow use of your version of this file only
  30.  * under the terms of either the GPL or the LGPL, and not to allow others to
  31.  * use your version of this file under the terms of the MPL, indicate your
  32.  * decision by deleting the provisions above and replace them with the notice
  33.  * and other provisions required by the GPL or the LGPL. If you do not delete
  34.  * the provisions above, a recipient may use your version of this file under
  35.  * the terms of any one of the MPL, the GPL or the LGPL.
  36.  *
  37.  * ***** END LICENSE BLOCK ***** */
  38.  
  39. #ifndef nsXMLNameSpaceMap_h_
  40. #define nsXMLNameSpaceMap_h_
  41.  
  42. #include "nsVoidArray.h"
  43.  
  44. class nsIAtom;
  45.  
  46. /**
  47.  * nsXMLNameSpaceMap contains a set of prefixes which are mapped onto
  48.  * namespaces.  It allows the set to be searched by prefix or by namespace ID.
  49.  */
  50. class nsXMLNameSpaceMap
  51. {
  52. public:
  53.   /**
  54.    * Allocates a new nsXMLNameSpaceMap (with new()) and initializes it with the
  55.    * xmlns and xml namespaces.
  56.    */
  57.   static NS_HIDDEN_(nsXMLNameSpaceMap*) Create();
  58.  
  59.   /**
  60.    * Add a prefix and its corresponding namespace ID to the map.
  61.    * Passing a null |aPrefix| corresponds to the default namespace, which may
  62.    * be set to something other than kNameSpaceID_None.
  63.    */
  64.   NS_HIDDEN_(nsresult) AddPrefix(nsIAtom *aPrefix, PRInt32 aNameSpaceID);
  65.  
  66.   /**
  67.    * Add a prefix and a namespace URI to the map.  The URI will be converted
  68.    * to its corresponding namespace ID.
  69.    */
  70.   NS_HIDDEN_(nsresult) AddPrefix(nsIAtom *aPrefix, nsString &aURI);
  71.  
  72.   /* Remove a prefix from the map. */
  73.   NS_HIDDEN_(void) RemovePrefix(nsIAtom *aPrefix);
  74.  
  75.   /*
  76.    * Returns the namespace ID for the given prefix, if it is in the map.
  77.    * If |aPrefix| is null and is not in the map, then a null namespace
  78.    * (kNameSpaceID_None) is returned.  If |aPrefix| is non-null and is not in
  79.    * the map, then kNameSpaceID_Unknown is returned.
  80.    */
  81.   NS_HIDDEN_(PRInt32) FindNameSpaceID(nsIAtom *aPrefix) const;
  82.  
  83.   /**
  84.    * If the given namespace ID is in the map, then the first prefix which
  85.    * maps to that namespace is returned.  Otherwise, null is returned.
  86.    */
  87.   NS_HIDDEN_(nsIAtom*) FindPrefix(PRInt32 aNameSpaceID) const;
  88.  
  89.   /* Removes all prefix mappings. */
  90.   NS_HIDDEN_(void) Clear();
  91.  
  92.   ~nsXMLNameSpaceMap() { Clear(); }
  93.  
  94. private:
  95.   nsXMLNameSpaceMap() NS_HIDDEN;  // use Create() to create new instances
  96.  
  97.   nsVoidArray mNameSpaces;
  98. };
  99.  
  100. #endif
  101.